home *** CD-ROM | disk | FTP | other *** search
/ PD Collection CD 1 / PD Collection CD 1.iso / comms / serial / !Serialink / !Help next >
Text File  |  1994-11-23  |  6KB  |  115 lines

  1. Help for Serialink v0.90, © Simon Hatliff 1993.
  2.  
  3. Introduction
  4. ¨¨¨¨¨¨¨¨¨¨¨¨
  5. Serialink is a small RiscOS application to transfer files between two Acorn 32-bit machines via the serial port. It can do this multi-taskingly, and also provides a talk option.
  6.  
  7. Loading Serialink
  8. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  9. Load Serialink in the normal manor, by double clicking on it's icon in the directory viewer. An icon representing the serial port will appear to the left of the iconbar.
  10.  
  11. Clicking MENU on this icon will lead you to Serialink's menu.
  12. Clicking SELECT will open the Talk window.
  13. Clicking ADJUST will open the Choices window.
  14.  
  15. The Serialink menu
  16. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  17. The options on the Serialink menu are :
  18.  
  19. Info...    ⇨ Leads to a box showing information on the program & version.
  20. ------------
  21. Choices...   Click here to open the Choices window.
  22. Talk...      Click here to open the Talk window.
  23. Clear        Flush the serial buffer and remove any received files.
  24. Save as... ⇨ Leads to the save box of a received file (or greyed out).
  25. ------------
  26. Quit         Removes the application and any received files from memory.
  27.  
  28. The Choices window
  29. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  30. The choices window allows you to set up various options for Serialink.
  31.  
  32. You can set the Baud rate, data bits, parity and stop bits in the top part of the window. The baud rate must be one of the acceptable values by the OS (eg. 1200, 2400, 4800, 9600, 19200). The number of data bits (first of the three small writable icons) can be either 7 or 8. The parity (second small writable icon) can be 'N' for none, 'E' for even or 'O' for odd. The stop bits (third small writable icon) can be either 1 or 2.
  33.  
  34. In the 'Transfer settings' group of options, you can set the following :
  35.  
  36. • Multitasking transfer -- if this option is selected then Wimp_Poll will be called between each block, and the next block will not be sent until a null event is received.
  37. • Squash if uncompressed -- this option at present does nothing.
  38. • Chunk size -- you can set the chunk size to any whole number of bytes by entering the value into the writable icon. The default is 1024. When files are transferred they will be sent in chunks of this size. When used with the 'Multitasking transfer' option, the chunk size gives control over the level of multitasking.
  39.  
  40. Note that the chunk size used for a transfer is determined by the sender only, so the chunk size on the receiving end doesn't have to be the same.
  41.  
  42. You can Save the Choices as the defaults by clicking on 'Save', or you can click 'OK' to accept the choices and close the window.
  43.  
  44. The Talk window
  45. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  46. This function allows you to transfer short messages between the two machines, which could be handy if you are sending files to someone in another room and you want to let them know what's going on.
  47.  
  48. To send a line of text, enter it into the writable icon, then press Return (note that if you expand the window you will see a 'Send' button which is equivalent to pressing Return). When you press Return the writable icon will be cleared.
  49.  
  50. An incoming message will appear in the slabbed in icon above the writable icon. If an incoming message is received and the Talk window is not open, then it will be opened on top of the pile.
  51.  
  52. Transmitting a file
  53. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  54. To transmit a file, simply drag it to the Serialink icon on the icon bar, or to any Serialink window. A status window will open at both the sending and receiving end (the receiving end automatically detects the send and starts to receive), which keeps you informed of the transfer progress.
  55.  
  56. The status window remains open when the transfer is complete, and a save box will pop up allowing you to save the received file. If you lose the save box then use the 'Save as...' option from Serialink's menu. Note that the received file is kept in Serialink's memory until another file is sent or received, or until the 'Clear' option is chosen from the menu.
  57.  
  58. Errors during transfer
  59. ¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨¨
  60. If an error occurs during transfer then both ends will hang up for a short while and then a timeout error will be generated. Choosing 'Clear' from the menu at both ends and trying the transfer again should work, providing that your serial lead is wired up correctly.
  61.  
  62. Please note that if you have an A3000 you must have a serial upgrade fitted to use this program! (And of course you need two Acorn computers and a suitable lead!)
  63.  
  64. Future plans
  65. ¨¨¨¨¨¨¨¨¨¨¨¨
  66. I have a few ideas for future updates to Serialink :
  67.  
  68. • Optional automatic squashing of files which aren't already compressed (ie all but Spark, PackDir, Squash & Tar files). This should improve transfer times, and quite dramatically for sprites etc. Using this option will be a bit like using hardware compression on a modem.
  69. • Transfer of a batch of files; that is a directory or application, instead of just single files.
  70. • Allow transfer of files larger than memory.
  71.  
  72. Conditions
  73. ¨¨¨¨¨¨¨¨¨¨
  74. This application is Freeware and as such may be distributed freely so long as no profit is made from it in any way, and that it is not tampered with in any way, ie ALL FILES ARE LEFT INTACT AND UNTOUCHED, and no extra files are added.
  75.  
  76. The copyright remains mine at all times.
  77.  
  78. Contacts
  79. ¨¨¨¨¨¨¨¨
  80. How to contact me :
  81.  
  82. During university term time, I can be reached via email or snail mail :
  83.  
  84. email: simh@dcs.ed.ac.uk (or 9470261@mull.sms.ed.ac.uk)
  85.  
  86. snail: Simon Hatliff     (this address only valid until June '95)
  87.        20/11 Sciennes
  88.        Edinburgh
  89.        EH9 1NJ
  90.  
  91. During the holidays, I can be definately be contacted via snail mail, and possibly also by email :
  92.  
  93. snail: Simon Hatliff
  94.        4 Elmlands Grove
  95.        Stockton Lane
  96.        York
  97.        YO3 OEE
  98.  
  99. email: Send to one of my term time addresses and if you're lucky the mail will
  100.        be auto-forwarded to me somewhere. If you don't get a reply you'll have
  101.        to write :-(
  102.  
  103. Credits
  104. ¨¨¨¨¨¨¨
  105. Thanks to the authors of the following modules :
  106.  
  107.         IceManager    1.05 © Carl Declerk 1990
  108.         TimeOut       0.04 © John TYTGAT, BASS/PiSoft 1991
  109.         WimpExtension 2.07 © Jon Ribbens of DoggySoft, 1993
  110.  
  111. The desktop task was designed and programmed by myself.
  112.  
  113. © Simon Hatliff 1993
  114.  
  115. This help file, as all code, was written and edited in StrongED.